Routines (by topic) > Input/Output

Input/Output

General File Access

APP_USER_DIR - Provides access to the application user directory.

APP_USER_DIR_QUERY - Locates existing application user directories.

DIALOG_PICKFILE - Creates native file-selection dialog.

FILE_BASENAME - Returns the final segment of a file path.

FILE_CHMOD - Changes the current access permission associated with a file or directory.

FILE_COPY - Copies files or directories to a new location.

FILE_DELETE - Removes a file or empty directory.

FILE_DIRNAME - Returns the directory name of a file path consisting of everything except the final segment of the file path.

FILE_EXPAND_PATH - Returns a fully qualified path regardless of the current working directory.

FILE_INFO - Returns status information about a file.

FILE_LINES - Returns the number of lines of text in a file.

FILE_LINK - Creates Unix file links.

FILE_MKDIR - Creates a new directory or directories.

FILE_MOVE - Renames files and directories.

FILE_POLL_INPUT - Blocks processing until it detects that a read operation on a specified file will succeed.

FILE_READLINK - Returns the path pointed to by a Unix symbolic link.

FILE_SAME - Determines it two different file names refer to the same underlying file.

FILE_SEARCH - Returns a string array containing the names of all files matching the input path specification.

FILE_TEST - Test a file or directory for existence and other specific attributes.

FILE_WHICH - Returns the path for the first file for the given name found by searching the specified path.

FILEPATH - Returns full path to a file in the IDL distribution.

FSTAT - Returns information about a specified file unit.

PATH_SEP - Returns the proper file path segment separator character for the current operating system.

Image Data Formats

Note: Also see Query Routines.

DIALOG_READ_IMAGE - Presents GUI for reading image files.

DIALOG_WRITE_IMAGE - Presents GUI for writing image files.

GET_DXF_OBJECTS - Returns an IDLgrModel containing graphics from a given DXF file.

IDLffDICOM- Contains the data for one or more images embedded in a DICOM part 10 file.

IDLffJPEG2000- Contains the data for one or more JPEG2000 files.

IDLffMJPEG2000- Allows you to create and play Motion JPEG2000 animations contained in MJ2 files.

IDLffMrSID - Allows you to query and load image data from a MrSID image file.

IDLffVideoWrite - Allows you to write images to a video file, with an optional soundtrack.

READ_BMP - Reads Microsoft Windows bitmap file (.BMP).

READ_DICOM - Reads an image from a DICOM file.

READ_GIF - Reads GIF file (.GIF)

READ_IMAGE - Reads the image contents of a file and returns the image in an IDL variable.

READ_INTERFILE - Reads Interfile (v3.3) file.

READ_JPEG - Reads JPEG file.

READ_JPEG2000 - Reads JPEG 2000 file.

READ_MRSID - Reads MrSID file.

READ_PICT - Reads Macintosh PICT (version 2) bitmap file.

READ_PNG - Reads Portable Network Graphics (PNG) file.

READ_PPM - Reads PGM (gray scale) or PPM (portable pixmap for color) file.

READ_SRF - Reads Sun Raster Format file.

READ_TIFF - Reads TIFF format file.

READ_X11_BITMAP - Reads X11 bitmap file.

READ_XWD - Reads X Windows Dump file.

TVRD - Reads an image from a window into a variable. (Direct Graphics)

WRITE_BMP - Writes Microsoft Windows Version 3 device independent bitmap file (.BMP).

WRITE_GIF - Writes GIF file (.GIF).

WRITE_IMAGE - Writes an image and its color table vectors, if any, to a file of a specified type.

WRITE_JPEG - Writes JPEG file.

WRITE_JPEG2000 - Writes JPEG 2000 file.

WRITE_NRIF - Writes NCAR Raster Interchange Format rasterfile.

WRITE_PICT - Writes Macintosh PICT (version 2) bitmap file.

WRITE_PNG - Writes Portable Network Graphics (PNG) file.

WRITE_PPM - Writes PPM (true-color) or PGM (gray scale) file.

WRITE_SRF - Writes Sun Raster File (SRF).

WRITE_TIFF - Writes TIFF file with 1 to 3 channels.

XOBJVIEW_WRITE_IMAGE - Write the object currently displayed in XOBJVIEW to an image file.

HDF, NetCDF, and CDF Formats

H5_BROWSER - Opens a GUI to view contents of an HDF5 file.

HDF Routines - Hierarchical Data Format routines.

HDF5 Routines - Hierarchical Data Format routines (version 5).

HDF_BROWSER - Opens a GUI to view contents of HDF, HDF-EOS, or NetCDF file.

H5_BROWSER EOS Routines - HDF-EOS (Hierarchical Data Format-Earth Observing System) routines.

HDF_READ - Extracts HDF, HDF-EOS, and NetCDF data and metadata into an output structure.

NetCDF Routines - Network Common Data Format routines.

CDF Routines - Common Data Format routines.

GRIB Formats

GRIB Routines - Read and write GRIdded Binary (GRIB) 1 and GRIB 2 files.

Other Data Formats

ASCII_TEMPLATE - Presents a GUI that generates a template defining an ASCII file format.

BINARY_TEMPLATE - Presents a GUI for interactively generating a template structure for use with READ_BINARY.

JSON_PARSE - Converts a JSON (JavaScript Object Notation) string into an IDL variable.

JSON_SERIALIZE - Converts an IDL HASH or LIST variable into a JSON (JavaScript Object Notation) string.

IDLffDXF- Object that contains geometry, connectivity, and attributes for graphics primitives.

IDLffShape - Contains geometry, connectivity and attributes for graphics primitives accessed from ESRI Shapefiles.

IDLffXMLDOM Classes* - Classes that provide support for IDL’s XML Document Object Model (DOM).  

IDLffXMLSAX - Represents an XML SAX level 2 parser.

IDLgrVRML - Saves the contents of an Object Graphics hierarchy into a VRML 2.0 format file.

READ_ASCII - Reads data from an ASCII file.

READ_BINARY - Reads the contents of a binary file using a passed template or basic command line keywords.

READ_CSV - Reads data from an ASCII file containing comma-delimited data.

READ_SYLK - Reads Symbolic Link format spreadsheet file.

READ_WAV - Reads the audio stream from the named .WAV file.

READ_WAVE - Reads Wavefront Advanced Visualizer file.

WRITE_CSV - Writes comma-separated-values file (.CSV).

WRITE_SYLK - Writes SYLK (Symbolic Link) spreadsheet file.

WRITE_WAV - Writes the audio stream to the named .WAV file.

WRITE_WAVE - Writes Wavefront Advanced Visualizer (.WAV) file.

General Input/Output

ASSOC - Associates an array structure with a file.

CLOSE - Closes the specified files.

COPY_LUN - Copies data between two open files.

EOF - Tests the specified file for the end-of-file condition.

FLUSH - Flushes file unit buffers.

FREE_LUN - Frees previously-reserved file units.

GET_KBRD - Gets one input IDL character.

GET_LUN - Reserves a logical unit number (file unit).

IOCTL - Performs special functions on UNIX files.

OPENR/OPENU/OPENW - Opens files for reading, updating, or writing.

POINT_LUN - Sets or gets current position of the file pointer.

PRINT/PRINTF - Writes formatted output to screen or file.

READ/READF - Reads formatted input from keyboard or file.

READS - Reads formatted input from a string variable.

READU - Reads unformatted binary data from a file.

SEM_CREATE - Creates a reference to a semaphore in the current IDL process. Creates the semaphore itself if necessary.

SEM_DELETE - Destroys a reference to the specified semaphore in the current IDL process. Optionally destroys the semaphore itself.

SEM_LOCK - Attempts to gain the lock on an existing semaphore (created by a call to the SEM_CREATE function) for the current IDL process.

SEM_RELEASE - Releases the lock on the specified semaphore held by the current IDL process.

SHMMAP - Maps anonymous shared memory, or local disk files, into the memory address space of the currently executing IDL process.

SHMUNMAP - Removes a memory segment previously created by SHMMAP from the system.

SHMVAR - Creates an IDL array variable that uses the memory from a current mapped memory segment created by the SHMMAP procedure.

SKIP_LUN - Reads data in an open file and moves the file pointer.

SOCKET - Opens a client-side TCP/IP Internet socket as an IDL file unit.

TRUNCATE_LUN - Truncates an open file at the location of the current file pointer.

WRITEU - Writes unformatted binary data to a file.